<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Whisper: CGuiProtocolEngine Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Whisper
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a>  </div>
  <div class="headertitle">
<div class="title">CGuiProtocolEngine Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CGuiProtocolEngine" --><!-- doxytag: inherits="IStegIO" -->
<p>protocol engine for gui  
 <a href="classCGuiProtocolEngine.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="gui__protocol__engine_8h_source.html">gui_protocol_engine.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CGuiProtocolEngine:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classCGuiProtocolEngine.png" usemap="#CGuiProtocolEngine_map" alt=""/>
  <map id="CGuiProtocolEngine_map" name="CGuiProtocolEngine_map">
<area href="classIStegIO.html" title="abstraction layer of a steg payload data source and sink" alt="IStegIO" shape="rect" coords="0,0,126,24"/>
</map>
 </div></div>

<p><a href="classCGuiProtocolEngine-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a84295eeae8f8b6cbc1969c4b340710fc">CGuiProtocolEngine</a> (<a class="el" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a> *pConfig)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a9f0ceb6ed179cfd11752360c2f06f4d2">~CGuiProtocolEngine</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#afa041f52b16ecc730f37fb483ff21dba">open</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a1d6a980592509648b3fff12e02dee3a6">close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceNStegIO.html#a7e327c93e6134904ec18fdd7e7a72e80">NStegIO::EReadState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a282dc38ced65366d68d4fa4eb4aedae0">read</a> (unsigned char &amp;pByte)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a319afc1359f0392a7bd3d378be01fb8c">write</a> (unsigned char pByte)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a5b2ef1ee54e9f69966768b6fed23e01b">available</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get size of available bytes which can be read with the read methode. For example: If this methode return 19 then the read methode can be called 19 times without an EOF.  <a href="#a5b2ef1ee54e9f69966768b6fed23e01b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a1aea05219b67cc1d8e17431680d1be67">CGuiProtocolEngine</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a2f27b81d1a2098637bb98faad37e8421">CGuiProtocolEngine</a> (const <a class="el" href="classCGuiProtocolEngine.html">CGuiProtocolEngine</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCGuiProtocolEngine.html">CGuiProtocolEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a1a1af78051ab66b04365629dce778f51">operator=</a> (const <a class="el" href="classCGuiProtocolEngine.html">CGuiProtocolEngine</a> &amp;)</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#ab4353e5505fcba4443b4512bfcecbdeb">mConfig</a></td></tr>
<tr><td colspan="2"><h2><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCGuiProtocolEngine.html#a0218124529e7b6e776ba691f70799637">sIniSectionName</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>protocol engine for gui </p>
<dl class="author"><dt><b>Author:</b></dt><dd>jwurzer </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>capable to operate in full duplex </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a84295eeae8f8b6cbc1969c4b340710fc"></a><!-- doxytag: member="CGuiProtocolEngine::CGuiProtocolEngine" ref="a84295eeae8f8b6cbc1969c4b340710fc" args="(CPropertiesReader *pConfig)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CGuiProtocolEngine::CGuiProtocolEngine </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a> *&#160;</td>
          <td class="paramname"><em>pConfig</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pFilenameRead</td><td>file containing the data that is <b>sent</b> </td></tr>
    <tr><td class="paramname">pFilenameWrite</td><td>file containing the data that is <b>received</b> </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a9f0ceb6ed179cfd11752360c2f06f4d2"></a><!-- doxytag: member="CGuiProtocolEngine::~CGuiProtocolEngine" ref="a9f0ceb6ed179cfd11752360c2f06f4d2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CGuiProtocolEngine::~CGuiProtocolEngine </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a1aea05219b67cc1d8e17431680d1be67"></a><!-- doxytag: member="CGuiProtocolEngine::CGuiProtocolEngine" ref="a1aea05219b67cc1d8e17431680d1be67" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CGuiProtocolEngine::CGuiProtocolEngine </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a2f27b81d1a2098637bb98faad37e8421"></a><!-- doxytag: member="CGuiProtocolEngine::CGuiProtocolEngine" ref="a2f27b81d1a2098637bb98faad37e8421" args="(const CGuiProtocolEngine &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CGuiProtocolEngine::CGuiProtocolEngine </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCGuiProtocolEngine.html">CGuiProtocolEngine</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5b2ef1ee54e9f69966768b6fed23e01b"></a><!-- doxytag: member="CGuiProtocolEngine::available" ref="a5b2ef1ee54e9f69966768b6fed23e01b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int CGuiProtocolEngine::available </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>get size of available bytes which can be read with the read methode. For example: If this methode return 19 then the read methode can be called 19 times without an EOF. </p>
<p>This methode is necessary for <a class="el" href="classCFrameBuilder.html" title="Assembles bits to a frame. Splits a frame to bits.">CFrameBuilder</a>. Not for <a class="el" href="classCByteBuilder.html" title="Assembles bits to bytes. Splits bytes to bits.">CByteBuilder</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Count of available bytes for read. 0 for currently no available bytes. -1 for an error or if this methode is not supported. </dd></dl>

<p>Implements <a class="el" href="classIStegIO.html#a1f5389e760fba772e51fa68a51b8a286">IStegIO</a>.</p>

</div>
</div>
<a class="anchor" id="a1d6a980592509648b3fff12e02dee3a6"></a><!-- doxytag: member="CGuiProtocolEngine::close" ref="a1d6a980592509648b3fff12e02dee3a6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CGuiProtocolEngine::close </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implements <a class="el" href="classIStegIO.html#ad52003c75ca81e4fc06af5d61d8572c9">IStegIO</a>.</p>

</div>
</div>
<a class="anchor" id="afa041f52b16ecc730f37fb483ff21dba"></a><!-- doxytag: member="CGuiProtocolEngine::open" ref="afa041f52b16ecc730f37fb483ff21dba" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CGuiProtocolEngine::open </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implements <a class="el" href="classIStegIO.html#a84905da02c804db25caae639f21cc5e6">IStegIO</a>.</p>

</div>
</div>
<a class="anchor" id="a1a1af78051ab66b04365629dce778f51"></a><!-- doxytag: member="CGuiProtocolEngine::operator=" ref="a1a1af78051ab66b04365629dce778f51" args="(const CGuiProtocolEngine &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCGuiProtocolEngine.html">CGuiProtocolEngine</a>&amp; CGuiProtocolEngine::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCGuiProtocolEngine.html">CGuiProtocolEngine</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a282dc38ced65366d68d4fa4eb4aedae0"></a><!-- doxytag: member="CGuiProtocolEngine::read" ref="a282dc38ced65366d68d4fa4eb4aedae0" args="(unsigned char &amp;pByte)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceNStegIO.html#a7e327c93e6134904ec18fdd7e7a72e80">NStegIO::EReadState</a> CGuiProtocolEngine::read </td>
          <td>(</td>
          <td class="paramtype">unsigned char &amp;&#160;</td>
          <td class="paramname"><em>pByte</em></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implements <a class="el" href="classIStegIO.html#a2563a1768ad868b0da905917ab47faca">IStegIO</a>.</p>

</div>
</div>
<a class="anchor" id="a319afc1359f0392a7bd3d378be01fb8c"></a><!-- doxytag: member="CGuiProtocolEngine::write" ref="a319afc1359f0392a7bd3d378be01fb8c" args="(unsigned char pByte)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CGuiProtocolEngine::write </td>
          <td>(</td>
          <td class="paramtype">unsigned char&#160;</td>
          <td class="paramname"><em>pByte</em></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implements <a class="el" href="classIStegIO.html#a862ec55f0ba36ec0c8a016cfac438575">IStegIO</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab4353e5505fcba4443b4512bfcecbdeb"></a><!-- doxytag: member="CGuiProtocolEngine::mConfig" ref="ab4353e5505fcba4443b4512bfcecbdeb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a>* <a class="el" href="classCGuiProtocolEngine.html#ab4353e5505fcba4443b4512bfcecbdeb">CGuiProtocolEngine::mConfig</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a0218124529e7b6e776ba691f70799637"></a><!-- doxytag: member="CGuiProtocolEngine::sIniSectionName" ref="a0218124529e7b6e776ba691f70799637" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string <a class="el" href="classCGuiProtocolEngine.html#a0218124529e7b6e776ba691f70799637">CGuiProtocolEngine::sIniSectionName</a><code> [static, private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="gui__protocol__engine_8h_source.html">gui_protocol_engine.h</a></li>
<li><a class="el" href="gui__protocol__engine_8cxx.html">gui_protocol_engine.cxx</a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 25 2012 22:00:43 for Whisper by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
